[]
        
在线Demo 免费试用
(Showing Draft Content)

Language-Packages

Language-Packages

[GET] /api/v2/ui/common/language-packages

根据指定类型获取语言包。

参数:

名称 类型 位置 描述
type LanguagePackageType query 要获取的包类型。1:自定义(默认),2:官方,3:全部

返回值

状态码: 200

成功

QueryLanguagePackagesResponseModel

状态码: 400

错误的请求

CLPErrorRequestResult

[POST] /api/v2/ui/common/language-packages

创建新的自定义语言包

请求数据格式

LanguagePackagePostModel

返回值

状态码: 200

成功

PackageResponseModel

状态码: 400

错误的请求

CLPErrorRequestResult

[DELETE] /api/v2/ui/common/language-packages/{packageId}

根据指定的包id删除自定义语言包。

参数:

名称 类型 位置 描述
packageId必填项 string path 要删除的包 ID
forceDelete Boolean query 仅当删除官方语言包时使用

返回值

状态码: 204

无内容

状态码: 400

错误的请求

CLPErrorRequestResult

状态码: 404

未找到

CLPErrorRequestResult

[POST] /api/v2/ui/common/language-packages/upload

返回值

状态码: 200

成功

CustomLanguagePackageUploadModel

状态码: 400

错误的请求

CLPErrorRequestResult

[POST] /api/v2/ui/common/language-packages/commit/{displayName}/{sessionId}

提交上传会话以创建新的自定义语言包

参数:

名称 类型 位置 描述
displayName必填项 string path 新的自定义语言包的显示名称
sessionId必填项 string path 上传 API 返回的会话 ID

返回值

状态码: 200

成功

PackageResponseModel

状态码: 400

错误的请求

CLPErrorRequestResult

状态码: 404

未找到

CLPErrorRequestResult

[POST] /api/v2/ui/common/language-packages/import

导入自定义语言包

返回值

状态码: 200

成功

CustomLanguagePackageUploadModel

状态码: 400

错误的请求

CLPErrorRequestResult

[POST] /api/v2/ui/common/language-packages/import/{sessionId}/submit

提交导入会话以创建新的自定义语言包

参数:

名称 类型 位置 描述
sessionId必填项 string path 导入 API 返回的会话 ID

返回值

状态码: 200

成功

PackageResponseModel

状态码: 400

错误的请求

CLPErrorRequestResult

状态码: 404

未找到

CLPErrorRequestResult

[POST] /api/v2/ui/common/language-packages/{packageId}/migrate

将自定义语言包迁移到当前生产版本

参数:

名称 类型 位置 描述
packageId必填项 string path 自定义语言包 ID

返回值

状态码: 204

无内容

状态码: 400

错误的请求

CLPErrorRequestResult

状态码: 404

未找到

CLPErrorRequestResult

[POST] /api/v2/ui/common/language-packages/{packageId}/publish

发布草稿

参数:

名称 类型 位置 描述
packageId必填项 string path 包裹编号

返回值

状态码: 204

无内容

状态码: 400

错误的请求

CLPErrorRequestResult

状态码: 404

未找到

CLPErrorRequestResult

[GET] /api/v2/ui/common/language-packages/supported-cultures

获取当前服务器节点支持的所有文化

返回值

状态码: 200

成功

SupportCultureViewModel

状态码: 400

错误的请求

CLPErrorRequestResult

[GET] /api/v2/ui/common/language-packages/{packageId}/download

下载一些语言包(官方和自定义)

参数:

名称 类型 位置 描述
packageId必填项 string path 要下载的包 ID

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

CLPErrorRequestResult

状态码: 404

未找到

CLPErrorRequestResult

[POST] /api/v2/ui/common/language-packages/{packageId}/export

导出语言包的内容

参数:

名称 类型 位置 描述
packageId必填项 string path 包裹 ID

请求数据格式

ExportPostModel

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

CLPErrorRequestResult

状态码: 404

未找到

CLPErrorRequestResult

类型定义

Ƭ LanguagePackageType

Enum:

  • Custom
  • Official
  • All

表示系统中可用的语言包类型。

* Custom - 0 - 表示用户创建的自定义语言包。
* Official - 1 - 表示系统提供的官方语言包。
* All - 2 - 表示所有类型的语言包,包括自定义语言包和官方语言包。

Ƭ QueryLanguagePackagesResponseModel

表示查询语言包的响应模型。

名称 类型 描述 示例
languagePackages可为空 LanguagePackageViewModel 查询返回的语言包列表。

Ƭ LanguagePackageViewModel

表示包含有关语言包详细信息的语言包视图模型。

名称 类型 描述 示例
id可为空 string 获取或设置语言包的唯一标识符。
lang-package-123
languageCode可为空 string 获取或设置语言包的语言代码。
英文
name可为空 string 获取或设置语言包的名称。
英语语言包
displayName可为空 string 获取或设置语言包的显示名称。
英语
publishTime ISO DateTime Sting 获取或设置语言包的发布时间。
2023-10-01T12:00:00
createdTime ISO DateTime Sting 获取或设置语言包的创建时间。
2023-10-01T12:00:00
modifiedTime ISO DateTime Sting 获取或设置语言包的修改时间。
2023-10-01T12:00:00
version可为空 string 获取或设置语言包的版本。
1.0.0
productVersion可为空 string 获取或设置与语言包关联的产品版本。
6
isOfficial Boolean 获取或设置一个值,指示语言包是否为官方语言包。
真的
published Boolean 获取或设置一个值,指示语言包是否已发布。
错误的
hasDraft Boolean 获取或设置一个值,指示语言包是否有草稿。
真的
hasMigrated Boolean 获取或设置一个值,指示语言包是否已迁移。
错误的
referenceLanguage可为空 string 获取或设置语言包的参考语言。
英文
uploadTime ISO DateTime Sting 获取或设置语言包的上传时间。
2023-10-01T12:00:00
uploadBy可为空 string 获取或设置上传语言包的用户。
行政

Ƭ CLPErrorRequestResult

自定义语言包错误或警告响应结果

名称 类型 描述 示例
warnings可为空 CLPWarning CLPErrorRequestResult 警告
code可为空 string 错误代码
message可为空 string 错误信息
context可为空 string 错误上下文
innerError ServerPluginError
extensions可为空 any 扩展结果

Ƭ CLPWarning

表示自定义语言包警告。

名称 类型 描述 示例
code可为空 string 警告代码。
W001
message可为空 string 警告消息。
语言代码无效。
context可为空 string

Ƭ ServerPluginError

服务器插件错误

名称 类型 描述 示例
code可为空 string 错误代码
message可为空 string 错误信息
context可为空 string 错误上下文
innerError ServerPluginError
extensions可为空 any 扩展结果

Ƭ PackageResponseModel

表示包的响应模型。

名称 类型 描述 示例
packageId可为空 string 包的唯一标识符。

Ƭ LanguagePackagePostModel

用于创建自定义语言包的模型。

名称 类型 描述 示例
displayName string 获取或设置语言包的显示名称。
自定义语言包
languageCode string 获取或设置语言包的语言代码。
fr-FR
referenceLanguage string 需要引用的语言包的语言代码。
注意:我们将把创建的包的引用代码设置为官方包。
该属性指定从哪个语言包中复制内容。
英文

Ƭ CustomLanguagePackageUploadModel

表示上传自定义语言包的模型。

名称 类型 描述 示例
sessionId可为空 string 获取或设置上载的会话标识符。
会话-123
warnings可为空 UploadWarning

Ƭ UploadWarning

表示上传过程中出现警告。

名称 类型 描述 示例
code可为空 string 获取或设置警告代码。
W002
message可为空 string 获取或设置警告消息。
未找到文件。

Ƭ SupportCultureViewModel

表示所支持文化的视图模型。

名称 类型 描述 示例
code可为空 string 获取或设置文化代码。
英文
nativeName可为空 string 获取或设置文化的本地名称。
英语

Ƭ ExportPostModel

代表出口业务的模型。

名称 类型 描述 示例
type ExportAndImportType
fileNames可为空 Array<string>

Ƭ ExportAndImportType

Enum:

  • Entire
  • Partial
  • UpgradationDiff